/*
 * Copyright 2011 The Rusted Roof, LLC.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

package org.proteusframework.platformservice.lifecycle.api;

/**
 * Represents an activity based event to a lifecycle listener as it relates to a given {@link LifecycleContext} and
 * {@link LifecyclePhase}.
 * <p/>
 * These are project- and document-centric lifecycle activities.
 */
public enum LifecycleActivity
{
    Start,
    Stop,

    /**
     * Message bean registration in a project during project bootstrapping.
     * <p/>
     * Typically, the Pre-Registration event is where an app submits their message beans to the database for
     * processing and registration, and the Post-Registration event is where any pre-population of database
     * records occurs.
     */
    MessageBeanRegistration,

    /**
     * Virtual File System file population in a project during project bootstrapping.
     * <p/>
     * Typically, the Pre-Population event is where template or default files are copied into the VFS; write-only
     * operations can occur. During the Post-Registration event, both read and write operations are permitted.
     */
    VFSInitialization,

    /**
     * New project creation.
     */
    Create,

    /**
     * Open a project.
     */
    Open,

    /**
     * Delete a project.
     */
    Delete,

    /**
     * Save a project.
     */
    Save,

    /**
     * Save a project under a different name.
     */
    SaveAs,
    Print,

    /**
     * Close a project.
     */
    Close,
    Revert
}
